Raw switch for jsondoc
#24568
Open
Raw switch for jsondoc
#24568
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Chose that name since thats what the issue had, open to suggestions for any other name
Now we remove the rst field so that it doesn't try and render it and instead set the description ourselves
…ess edge cases from needing to handle it at the edges Uses optionals to represent the nil state
Add newline between each section
Add entry into changelog
Araq
reviewed
Jan 3, 2025
| if n.comment.len > 0: | ||
| if optDocRaw in d.conf.globalOptions: |
There was a problem hiding this comment.
Why check this recursively here and then wrap everything in an option when you can do the same at the callsite instead?
There was a problem hiding this comment.
My reasoning was that there is a few callsites for genComment so was safer to do it here in case I forgot somewhere
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implements #21928
Adds a
--raw(since thats what the original issue used, suggestions welcome) switch which stops the jsondoc gen from rendering rst/markdown.Implemented by making
genCommentcheck if it needs to return the raw string or not. This required switching the related procs to usingOptionto handle hownilvalues were returned before. Thenilreturns were eventually ignored so just ignoringnone(T)has the same effect.Doesn't support
runnableExamplessince jsondocs doesn't support them either